home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / mann / menubutton.n < prev    next >
Text File  |  1994-09-20  |  13KB  |  417 lines
  1. '\"
  2. '\" Copyright (c) 1990-1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/menubutton.n,v 1.15 93/04/01 09:52:46 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS menubutton tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. menubutton \- Create and manipulate menubutton widgets
  210. .SH SYNOPSIS
  211. \fBmenubutton\fI \fIpathName \fR?\fIoptions\fR?
  212. .SH "STANDARD OPTIONS"
  213. .LP
  214. .nf
  215. .VS
  216. .ta 4c 8c 12c
  217. \fBactiveBackground\fR    \fBbitmap\fR    \fBfont\fR    \fBrelief\fR
  218. \fBactiveForeground\fR    \fBborderWidth\fR    \fBforeground\fR    \fBtext\fR
  219. \fBanchor\fR    \fBcursor\fR    \fBpadX\fR    \fBtextVariable\fR
  220. \fBbackground\fR    \fBdisabledForeground\fR    \fBpadY\fR    \fBunderline\fR
  221. .VE
  222. .fi
  223. .LP
  224. See the ``options'' manual entry for details on the standard options.
  225. .SH "WIDGET-SPECIFIC OPTIONS"
  226. .ta 4c
  227. .LP
  228. .nf
  229. .VS
  230. Name:    \fBheight\fR
  231. Class:    \fBHeight\fR
  232. Command-Line Switch:    \fB\-height\fR
  233. .fi
  234. .IP
  235. Specifies a desired height for the menu button.
  236. If a bitmap is being displayed in the menu button then the value is in
  237. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  238. for text it is in lines of text.
  239. If this option isn't specified, the menu button's desired height is computed
  240. from the size of the bitmap or text being displayed in it.
  241. .VE
  242. .LP
  243. .nf
  244. Name:    \fBmenu\fR
  245. Class:    \fBMenuName\fR
  246. Command-Line Switch:    \fB\-menu\fR
  247. .fi
  248. .IP
  249. Specifies the path name of the menu associated with this menubutton.
  250. .VS
  251. The menu must be a descendant of the menubutton in order for normal pull-down
  252. operation to work via the mouse.
  253. .VE
  254. .LP
  255. .nf
  256. Name:    \fBstate\fR
  257. Class:    \fBState\fR
  258. Command-Line Switch:    \fB\-state\fR
  259. .fi
  260. .IP
  261. Specifies one of three states for the menu button:  \fBnormal\fR, \fBactive\fR,
  262. or \fBdisabled\fR.  In normal state the menu button is displayed using the
  263. \fBforeground\fR and \fBbackground\fR options.  The active state is
  264. typically used when the pointer is over the menu button.  In active state
  265. the menu button is displayed using the \fBactiveForeground\fR and
  266. \fBactiveBackground\fR options.  Disabled state means that the menu button
  267. is insensitive:  it doesn't activate and doesn't respond to mouse
  268. button presses.  In this state the \fBdisabledForeground\fR and
  269. \fBbackground\fR options determine how the button is displayed.
  270. .LP
  271. .nf
  272. .VS
  273. Name:    \fBwidth\fR
  274. Class:    \fBWidth\fR
  275. Command-Line Switch:    \fB\-width\fR
  276. .fi
  277. .IP
  278. Specifies a desired width for the menu button.
  279. If a bitmap is being displayed in the menu button then the value is in
  280. screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
  281. for text it is in characters.
  282. If this option isn't specified, the menu button's desired width is computed
  283. from the size of the bitmap or text being displayed in it.
  284. .VE
  285. .BE
  286.  
  287. .SH INTRODUCTION
  288. .PP
  289. The \fBmenubutton\fR command creates a new window (given by the
  290. \fIpathName\fR argument) and makes it into a menubutton widget.
  291. Additional
  292. options, described above, may be specified on the command line
  293. or in the option database
  294. to configure aspects of the menubutton such as its colors, font,
  295. text, and initial relief.  The \fBmenubutton\fR command returns its
  296. \fIpathName\fR argument.  At the time this command is invoked,
  297. there must not exist a window named \fIpathName\fR, but
  298. \fIpathName\fR's parent must exist.
  299. .PP
  300. A menubutton is a widget that displays a
  301. .VS
  302. textual string or bitmap
  303. .VE
  304. and is associated with a menu widget.  In normal usage, pressing
  305. mouse button 1 over the menubutton causes the associated menu to
  306. be posted just underneath the menubutton.  If the mouse is moved over
  307. the menu before releasing the mouse button, the button release
  308. causes the underlying menu entry to be invoked.  When the button
  309. is released, the menu is unposted.
  310. .PP
  311. .VS
  312. Menubuttons are typically organized into groups called menu bars
  313. that allow scanning:
  314. if the mouse button is pressed over one menubutton (causing it
  315. to post its menu) and the mouse is moved over another menubutton
  316. in the same menu bar without releasing the mouse button, then the
  317. menu of the first menubutton is unposted and the menu of the
  318. new menubutton is posted instead.
  319. The \fBtk_menuBar\fR procedure is used to set up menu bars for
  320. scanning; see that procedure for more details.
  321. .VE
  322.  
  323. .SH "WIDGET COMMAND"
  324. .PP
  325. The \fBmenubutton\fR command creates a new Tcl command whose
  326. name is \fIpathName\fR.  This
  327. command may be used to invoke various
  328. operations on the widget.  It has the following general form:
  329. .DS C
  330. \fIpathName option \fR?\fIarg arg ...\fR?
  331. .DE
  332. \fIOption\fR and the \fIarg\fRs
  333. determine the exact behavior of the command.  The following
  334. commands are possible for menubutton widgets:
  335. .TP
  336. \fIpathName \fBactivate\fR
  337. Change the menu button's state to \fBactive\fR and redisplay the menu
  338. button using its active foreground and background colors instead of normal
  339. colors.
  340. The command returns an empty string.
  341. .VS
  342. This command is ignored if the menu button's state is \fBdisabled\fR.
  343. This command is obsolete and will eventually be removed;
  344. use ``\fIpathName \fBconfigure \-state active\fR'' instead.
  345. .VE
  346. .TP
  347. \fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
  348. Query or modify the configuration options of the widget.
  349. If no \fIoption\fR is specified, returns a list describing all of
  350. the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
  351. information on the format of this list).  If \fIoption\fR is specified
  352. with no \fIvalue\fR, then the command returns a list describing the
  353. one named option (this list will be identical to the corresponding
  354. sublist of the value returned if no \fIoption\fR is specified).  If
  355. one or more \fIoption\-value\fR pairs are specified, then the command
  356. modifies the given widget option(s) to have the given value(s);  in
  357. this case the command returns an empty string.
  358. \fIOption\fR may have any of the values accepted by the \fBmenubutton\fR
  359. command.
  360. .TP
  361. \fIpathName \fBdeactivate\fR
  362. Change the menu button's state to \fBnormal\fR and redisplay the menu
  363. button using its normal foreground and background colors.
  364. The command returns an empty string.
  365. .VS
  366. This command is ignored if the menu button's state is \fBdisabled\fR.
  367. This command is obsolete and will eventually be removed;
  368. use ``\fIpathName \fBconfigure \-state normal\fR'' instead.
  369. .VE
  370.  
  371. .SH "DEFAULT BINDINGS"
  372. .PP
  373. .VS
  374. Tk automatically creates class bindings for menu buttons that give them
  375. the following default behavior:
  376. .IP [1]
  377. A menu button activates whenever the mouse passes over it and deactivates
  378. whenever the mouse leaves it.
  379. .IP [2]
  380. A menu button's relief is changed to raised whenever mouse button 1 is
  381. pressed over it, and the relief is restored to its original value
  382. when button 1 is later released or the mouse is dragged into another
  383. menu button in the same menu bar.
  384. .IP [3]
  385. When mouse button 1 is pressed over a menu button, or when the mouse
  386. is dragged into a menu button with mouse button 1 pressed, the associated
  387. menu is posted;  the mouse can be dragged across the menu and released
  388. over an entry in the menu to invoke that entry.  The menu is unposted
  389. when button 1 is released outside either the menu or the menu button.
  390. The menu is also unposted when the mouse is dragged into another
  391. menu button in the same menu bar.
  392. .IP [4]
  393. If mouse button 1 is pressed and released within the menu button,
  394. then the menu stays posted and keyboard traversal is possible as
  395. described in the manual entry for \fBtk_menuBar\fR.
  396. .IP [5]
  397. Menubuttons may also be posted by typing characters on the keyboard.
  398. See the manual entry for \fBtk_menuBar\fR for full details on keyboard
  399. menu traversal.
  400. .IP [6]
  401. If mouse button 2 is pressed over a menu button then the associated
  402. menu is posted and also \fItorn off\fR:  it can then be dragged around on
  403. the screen with button 2 and the menu will not automatically unpost when
  404. entries in it are invoked.
  405. To close a torn off menu, click mouse button 1 over the associated
  406. menu button.
  407. .PP
  408. If the menu button's state is \fBdisabled\fR then none of the above
  409. actions occur:  the menu button is completely non-responsive.
  410. .PP
  411. The behavior of menu buttons can be changed by defining new bindings for
  412. individual widgets or by redefining the class bindings.
  413. .VE
  414.  
  415. .SH KEYWORDS
  416. menubutton, widget
  417.